API Reference: Libraries

 Top

vxbW83627dhgK

NAME

vxbW83627dhgK - Driver for the hardware monitoring functionality of the Winbond W83627DHG Super-I/O chip

ROUTINES

vxbW83627dhgDrvRegister( ) - register template sensor driver
W83627dhgInstInit( ) - first level initialization routine of sensor device
W83627dhgInstInit2( ) - second level initialization routine of sensor device
W83627dhgInstConnect( ) - third level initialization routine of sensor device
W83627dhgShow( ) - show routine
W83627dhgTempGet( ) - retrieve the value of the current temperature
W83627dhgTempGetMax( ) - retrieve the maximum value of the temperature
W83627dhgTempHyst( ) - retrieve temperature sensor hysteresis values
W83627dhgVoltageGet( ) - retrieve voltage values
W83627dhgFanGet( ) - retrieve fan values
W83627dhgSetFanSpeed( ) - set fan speed value

DESCRIPTION

    This driver provides support for the Winbond W83627DHG hardware monitor. 
    There are functions available to read the operating voltage of the CPU 
    and power supply voltages of the system, CPU and system temperature, speed of fans.

    User application is able to get information from device using 
    VxBus custom methods defined for this driver: 
    METHOD_DECL(vxbTempGet);
    METHOD_DECL(vxbTempGetMax);
    METHOD_DECL(vxbTempGetHyst);
    METHOD_DECL(sensorShow);
    METHOD_DECL(vxbVoltageGet);
    METHOD_DECL(vxbFanGet);
    METHOD_DECL(vxbSetFanSpeed);


API Reference: Routines

 Top

vxbW83627dhgDrvRegister( )

NAME

vxbW83627dhgDrvRegister( ) - register template sensor driver

SYNOPSIS

void vxbW83627dhgDrvRegister(void)

DESCRIPTION

This routine registers the template sensor driver with the VxBus subsystem.

This routine contains the first instructions of the device driver that are ever executed within a VxWorks system. This function registers the driver with VxBus by providing pointers to the data structures listed previously. Once this step is complete, VxWorks is able to associate this driver with appropriate hardware within the system to form an instance.

RETURNS

N/A

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgInstInit( )

NAME

W83627dhgInstInit( ) - first level initialization routine of sensor device

SYNOPSIS

void W83627dhgInstInit (VXB_DEVICE_ID pInst)

DESCRIPTION

This is the function called to perform the first level initialization of the template sensor device.

NOTE

This routine is called early during system initialization, and *MUST NOT* make calls to OS facilities such as memory allocation and I/O.

PARAMETERS

pInst - device identifier

RETURNS

N/A

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgInstInit2( )

NAME

W83627dhgInstInit2( ) - second level initialization routine of sensor device

SYNOPSIS

void W83627dhgInstInit2 (VXB_DEVICE_ID pInst)

DESCRIPTION

This routine performs the second level initialization of the sensor device.

NOTE

This routine is called later during system initialization. OS features such as memory allocation are available at this time.

PARAMETERS

pInst - device identifier

RETURNS

N/A

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgInstConnect( )

NAME

W83627dhgInstConnect( ) - third level initialization routine of sensor device

SYNOPSIS

void W83627dhgInstConnect (VXB_DEVICE_ID pInst)

DESCRIPTION

This is the function called to perform the third level initialization of the sensor device.

PARAMETERS

pInst - device identifier

RETURNS

N/A

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgShow( )

NAME

W83627dhgShow( ) - show routine

SYNOPSIS

void W83627dhgShow (VXB_DEVICE_ID pInst)

DESCRIPTION

   This routine prints information about the instance to the system
   console.  This is integrated with vxBusShow.

PARAMETERS

   pInst - device identifier

RETURNS

0, always

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgTempGet( )

NAME

W83627dhgTempGet( ) - retrieve the value of the current temperature

SYNOPSIS

STATUS W83627dhgShow (VXB_DEVICE_ID pInst, INT8* sysTemp, double* cpuTemp, double* auxTemp )

DESCRIPTION

   This function retrives current temperature values for system, CPU and auxiliary device

PARAMETERS

   pInst   - device identifier,
   sysTemp - system current temperature,
   cpuTemp - CPU current temperature,
   auxTemp - auxiliary device current temperature.

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgTempGetMax( )

NAME

W83627dhgTempGetMax( ) - retrieve the maximum value of the temperature

SYNOPSIS

STATUS W83627dhgTempMax ( VXB_DEVICE_ID pInst, INT8* sysTempMax, double* cpuTempMax, double* auxTempMax )

DESCRIPTION

   This function retrives maximum temperature values for system, CPU and auxiliary device

PARAMETERS

   pInst       - device identifier,
   sysTempMax  - system maximum temperature,
   cpuTempMax  - CPU maximum temperature, 
   auxTempMax  - auxiliary device maximum temperature.

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgTempHyst( )

NAME

W83627dhgTempHyst( ) - retrieve temperature sensor hysteresis values

SYNOPSIS

STATUS W83627dhgTempHyst ( VXB_DEVICE_ID pInst, INT8* sysTempHyst, double* cpuTempHyst, double* auxTempHyst )

DESCRIPTION

   This function retrives temperature sensor hysteresis values for system, CPU and auxiliary device

PARAMETERS

  pInst       - device identifier,
  sysTempHyst - system temperature sensor hysteresis,
  cpuTempHyst - CPU temperature sensor hysteresis,
  auxTempHyst - auxiliary device temperature sensor hysteresis.

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgVoltageGet( )

NAME

W83627dhgVoltageGet( ) - retrieve voltage values

SYNOPSIS

LOCAL STATUS W83627dhgVoltageGet ( VXB_DEVICE_ID pInst, double* voltage, double* HighLimit, double* LowLimit, char* name, int n )

DESCRIPTION

   This function retrives output voltage (mV), high/low limits of output voltage (mV), output name.

PARAMETERS

  VXB_DEVICE_ID pInst     - device identifier,
  double*       voltage   - output voltage value,
  double*       HighLimit - output voltage high limit,
  double*       LowLimit  - output voltage low limit,
      char*         name      - output name,
      int           n         - output number.

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgFanGet( )

NAME

W83627dhgFanGet( ) - retrieve fan values

SYNOPSIS

LOCAL STATUS W83627dhgFanGet ( VXB_DEVICE_ID pInst, UINT16* fan, UINT16* min, UINT8* div, int n )

DESCRIPTION

   This function retrives fan speed (revolution per minute), minimum fan speed, divisor

PARAMETERS

  VXB_DEVICE_ID pInst - device identifier ,
  UINT16* fan         - fan speed in revolutuion per minute,
  UINT16*     min         - minimum fan speed in revolutuion per minute,
  UINT8*  div         - fan divisor value,
      int     n           - fan number.

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgSetFanSpeed( )

NAME

W83627dhgSetFanSpeed( ) - set fan speed value

SYNOPSIS

LOCAL STATUS W83627dhgSetFanSpeed ( VXB_DEVICE_ID pInst, UINT8 n, UINT8 val )

DESCRIPTION

   This function sets fan speed value (for PWM or DC mode)

PARAMETERS

  VXB_DEVICE_ID pInst     - device identifier,
      UINT8 n,                                - fan number,
      UINT8 val                           - fan speed value to set.

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK